home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 1 / Cream of the Crop 1.iso / WINDOWS / SOFTERM1.ARJ / HOSTMODE.DOC next >
Text File  |  1992-08-18  |  26KB  |  633 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                       Host Mode
  8.                       The Softerm Host mode provides a general-purpose,
  9.                       unattended, remote access mode which can be used
  10.                       interactively by other terminals and systems.  This is
  11.                       similar to an electronic BBS.
  12.  
  13.                       Capabilties
  14.                       o Automatically answer incoming calls (with optional
  15.                         password protection provided by the SOFTERM.PWD file
  16.                         created with the PWDEDIT utility program)
  17.                       o Send and receive files using any protocol supported
  18.                         by Softerm
  19.                       o Function as a server for the Kermit-Server and
  20.                         Softrans file transfer protocols (meaning that a
  21.                         command to initiate the file transfer is not
  22.                         required)
  23.                       o Process DOS-type commands, such as:  DIR, TYPE,
  24.                         DELETE, RENAME
  25.                       o Process Script files automatically or on demand
  26.  
  27.                       Enter Host Mode
  28.                       Host mode is initiated by running the HOST() command
  29.                       from a Script file, such as:
  30.  
  31.                       > HOST (20,30,hangup,yes,'automenu.scr')
  32.  
  33.                       Note:  Host mode will go into effect with the current
  34.                       Speed, Data Bits, Stop Bits, Parity and Duplex
  35.                       parameters.
  36.  
  37.                       Operation
  38.                       When Host mode is in effect, Softerm will wait for a
  39.                       connection to be established.  If the optional logon
  40.                       processing is specified, a caller must supply a
  41.                       recognized username and password before Softerm
  42.                       displays the READY prompt and responds to valid
  43.                       commands.
  44.  
  45.                       Once initiated, Softerm will wait for a connection to
  46.                       be established if one is not already present, display
  47.                       a READY message after processing an optional logon,
  48.                       and wait for requests received through remote terminal
  49.                       interaction, or the Softrans or Kermit protocols.
  50.  
  51.                       A system in the Host mode functions in a passive
  52.                       manner, responding only to requests from the calling
  53.                       terminal or system.  Host mode allows completely
  54.                       unattended operation.  If logging is active, all
  55.                       commands processed, including error messages, will be
  56.                       recorded in the log file.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                       The TIMEOUT assignable system variable (in the Script
  64.                       language) does not affect file transfer operations
  65.                       initiated from the Host mode which has fixed or
  66.                       profiled timeout and retry parameters for all
  67.                       protocols supported.  The Softrans and Kermit
  68.                       protocols and Xmodem receive operations use a 10-
  69.                       second timeout interval and allow for 5 retries.
  70.                       Xmodem send operations will timeout after
  71.                       approximately 70 seconds.  The Character protocol uses
  72.                       a 30-second timeout on transmit and a 60-second
  73.                       timeout on receive.
  74.  
  75.                       The Host mode also provides an option to automatically
  76.                       run a script file on connecting after a successful
  77.                       login.  This can be used to display user welcome
  78.                       messages, instructions on how to perform various user-
  79.                       defined operations, or a security automatic callback
  80.                       capability.
  81.  
  82.                       Important
  83.                       To provide caller interaction, such as displaying a
  84.                       menu and waiting for a key, you will need to use the
  85.                       XMIT:WAIT Script file command.  To simply display a
  86.                       welcome message, you could use the file transfer SEND
  87.                       command using Character protocol.
  88.  
  89.                       The CALL command is provided to run script files
  90.                       interactively when requested by remote users.  The
  91.                       TERMINATE command lets a remote user terminate the
  92.                       Host mode to interact directly with the script file
  93.                       which initiated the Host mode.
  94.  
  95.                       Once the Host mode is initiated, it normally will
  96.                       remain active until terminated locally.
  97.  
  98.                       Optional Logon and Password Processing
  99.  
  100.                       Softerm provides an optional logon security feature
  101.                       to restrict access to the Host mode.  It includes the
  102.                       capability to assign a default directory to each
  103.                       user, and to restrict the type of commands each
  104.                       caller can process while using the Host mode.
  105.  
  106.                       To implement this feature, a special password file
  107.                       called SOFTERM.PWD must be created in the same
  108.                       directory as Softerm's system read files.  The
  109.                       password file is created with PWDEDIT.EXE, a GUI
  110.                       utility program supplied with Softerm Modular.  Note:
  111.                       PWDEDIT is documented completely through the online
  112.                       Help system.  Just press F1 or select the Help
  113.                       pushbutton.
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.                                               - 2 -
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.                       SOFTERM.PWD is a fixed-format ASCII file that appears
  128.                       similar to the following if the DOS TYPE command is
  129.                       used:
  130.  
  131.                       C:\SOFTERM>TYPE SOFTERM.PWD
  132.                       Jones, John        M_Ambrosius
  133.                                     <
  134.  
  135.                       Although access restrictions won't appear, names and
  136.                       passwords do.
  137.  
  138.                       Upper- and lower-case characters, except spaces, are
  139.                       valid in the username and password fields and must be
  140.                       matched exactly when entered by a remote user.  Each
  141.                       user name must be unique.  Multiple entries with the
  142.                       same user name are not valid and only the first
  143.                       occurrence can be matched.
  144.  
  145.                       When a remote user connects to a system in Host mode,
  146.                       and a SOFTERM.PWD file is found in the system
  147.                       directory, the following logon sequence is processed:
  148.  
  149.                       Host displays   User types
  150.                       Login           Username followed by CR
  151.                       Password        Password followed by CR
  152.                                       (echo is suppressed during entry of
  153.                                       the password)
  154.                       Ready           Any valid host mode command
  155.  
  156.                       Important:  Username and Password are case sensitive.
  157.                       For example, if the Username was created as SETH, it
  158.                       must be entered in upper- case characters.
  159.  
  160.                       If an error is made when entering the Username or
  161.                       Password, press Esc to cancel the entry and repeat
  162.                       the prompt.  If either the Username or Password is
  163.                       invalid when entered, the logon sequence will be
  164.                       repeated.  After four unsuccessful attempts to logon,
  165.                       a disconnect will occur.
  166.  
  167.                       Once a successful logon has been completed, any valid
  168.                       Host mode command or Softrans and Kermit file
  169.                       transfer can be processed subject to access restric-
  170.                       tions indicated in the password file for the user.
  171.                       After a Host mode session is complete, the remote
  172.                       user can use the BYE command to terminate and
  173.                       disconnect, or the LOGOUT command to terminate and
  174.                       restart processing without disconnecting.
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.                                               - 3 -
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.                       Host Mode Interactive Commands
  192.  
  193.                       The Host mode responds to interactive commands which
  194.                       are entered in the terminal communications mode at
  195.                       the remote system or terminal.  The READY prompt
  196.                       indicates it is ready to receive a command.
  197.  
  198.                       The host will respond to Ctrl S requests to stop the
  199.                       display of data and Ctrl Q requests to resume the
  200.                       display of data (such as when a file is TYPEd).
  201.  
  202.                       If you wish to cancel the entire command line, just
  203.                       press Esc.  Host mode will "beep", and display a new
  204.                       READY prompt for any command not recognized.  To
  205.                       cancel the display of a typed file or directory list,
  206.                       press Ctrl C.  If you press Ctrl S to stop the
  207.                       display of a typed file or directory list, the Host
  208.                       mode will timeout after 30 seconds and redisplay the
  209.                       READY prompt.
  210.  
  211.                       Many of the Host mode interactive commands require
  212.                       arguments.  The command and argument must be
  213.                       separated by at least one space.
  214.  
  215.                       Important
  216.                       All commands are issued by the caller and tell Host
  217.                       mode to do something.  For instance, to send a file,
  218.                       the caller must instruct Host mode to prepare to
  219.                       receive a file.
  220.  
  221.                       Exceptions to the Rule
  222.                       Because Host mode acts as a server for the Softrans
  223.                       and Kermit-Server file transfer protocols, there are
  224.                       no commands to send and receive using those
  225.                       protocols.  The caller simply needs to initiate the
  226.                       file transfer operation.
  227.  
  228.                       Unless stated otherwise, the following will be true
  229.                       for all operations:
  230.  
  231.                       1. If no path is specified, file transfers will use
  232.                          the current directory.
  233.                       2. If the optional Host mode logon processing is in
  234.                          effect, the command is restricted by the access
  235.                          restriction code and the path specified for the
  236.                          file is validated for the current username.
  237.                       3. Unless supported by the protocol, wildcard
  238.                          characters (* and ?) should not be used in the
  239.                          Source field on SEND operations.
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.                                               - 4 -
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.                       Interactive Commands
  256.  
  257.                       The following commands are entered by the caller to
  258.                       the Host system:
  259.  
  260.                       ACCEPT [-,&] d:\path\filename
  261.                       Used by the caller to send a file using character
  262.                       protocol.  The filename argument specifies the name
  263.                       of the file to receive the data.
  264.  
  265.                       If the very first character of the path\filename is a
  266.                       hyphen (-), the file will replace a file of the same
  267.                       name on the Host system.  Example:
  268.  
  269.                           ACCEPT -C:\SOFTHOST\TEST.TXT
  270.  
  271.                       If the very first character of the path/filename is
  272.                       an ampersand (&), the file will append to a file of
  273.                       the same name on the Host system.  Example:
  274.  
  275.                           ACCEPT &C:\SOFTHOST\TEST.TXT
  276.  
  277.                       If a file of the same name exists and neither special
  278.                       character is used, the transfer will fail.
  279.  
  280.                       The host will display a GO> prompt when the system is
  281.                       ready to accept data.  Characters can be typed by the
  282.                       caller or a file can be transferred using character
  283.                       protocol.
  284.  
  285.                       The ACCEPT command is terminated by a Ctrl Z
  286.                       character or a 60-second timeout.
  287.  
  288.                       BYE
  289.                       Terminate the current Host mode session and dis-
  290.                       connect.
  291.  
  292.                       CALL d:\path\filename 1='string1'...5='string5'
  293.                       Run a script file and then return to the Host mode.
  294.                       If logon processing is in effect, all subsequent
  295.                       commands will observe the access restrictions for the
  296.                       current user.
  297.  
  298.                       Note:  We recommend that the CALLed script file does
  299.                       not end with the CONVERSE command.  This command
  300.                       places the Host Mode machine in Online terminal
  301.                       emulation mode with unpredictable results.
  302.  
  303.                       The command line may include optional switches to
  304.                       specify the contents of the Script Variables SV1-SV5
  305.                       used in the script file as follows:
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.                                               - 5 -
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.                       Switch      Function
  320.                       1='string'  Replaces SV1 in script file
  321.                       .   .   .   .   .   .
  322.                       5='string'  Replaces SV5 in script file
  323.  
  324.                       Note:  The quote marks are optional and would be
  325.                       necessary only if the string contained embedded
  326.                       spaces.
  327.  
  328.                       Up to 5 strings can be specified which are
  329.                       substituted for dummy arguments in the script file
  330.                       when the script file is run.  Each string may be up
  331.                       to 64 characters in length.  A dummy argument is
  332.                       defined in the script file as SV followed by a number
  333.                       from 1 through 5.  Thus, wherever SV1 occurs in the
  334.                       script file, it will be replaced by the string
  335.                       defined for the SV1= switch in the CALL command line.
  336.                       Note:  The maximum length of the command line is
  337.                       restricted to 128 characters.
  338.  
  339.                       CD d:\path
  340.                       Change the current default directory used for file
  341.                       names specified in file transfer operations used in
  342.                       the Host mode.  The new default directory, including
  343.                       a drive specifier and directory path, is entered as
  344.                       an argument on the command line.  If the optional
  345.                       Host mode logon processing is in effect, the command
  346.                       is restricted by the access restriction code for the
  347.                       current username.
  348.  
  349.                       CURRENT
  350.                       Display the default directory for file transfer
  351.                       operations used in the Host mode.  It initially is
  352.                       set to the current default directory when the HOST()
  353.                       command is processed, or to the subdirectory in the
  354.                       password file for the current user.
  355.  
  356.                       DELETE d:\path\filename
  357.                       Remove an unwanted file from disk.  If no drive or
  358.                       directory path is entered, the file is deleted from
  359.                       the current directory.  You can use the wildcard
  360.                       characters ? and * in the filename and in the
  361.                       extension.
  362.  
  363.                       This command can be abbreviated to DEL.
  364.  
  365.                       DIR d:\path\filename
  366.                       The DIR command displays a list of the filenames in a
  367.                       specified directory.  If no drive or directory path
  368.                       is specified, all files in the current default
  369.                       directory will be listed.  The wildcard characters *
  370.                       and ? may be used in the filename and extension
  371.                       parameters to list a subset of the files in the
  372.                       specified directory.
  373.  
  374.  
  375.  
  376.                                               - 6 -
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.                       ECHO <On or Off>
  384.                       This command turns echo mode for the ACCEPT command
  385.                       on or off.  If the argument is specified as ON,
  386.                       characters transmitted to the host using an ACCEPT
  387.                       command will be echoed back to the remote terminal or
  388.                       system for visual confirmation.  If the argument is
  389.                       specified as OFF, characters received are not echoed.
  390.                       The echo mode defaults to ON.
  391.  
  392.                       HELP
  393.                       If the HOSTMODE.HLP file is available, the HELP
  394.                       command will display information about using the host
  395.                       mode and a list of commands.
  396.  
  397.                       KSEND d:\path\filename
  398.                       Prepare the Host system to send a file using the
  399.                       Kermit protocol.  This command can be used by remote
  400.                       Kermit programs unable to access a Kermit server.
  401.                       The command is equivalent to a Kermit protocol SEND
  402.                       command.  The wildcard characters * and ? may be used
  403.                       in the filename or extension to allow multiple files
  404.                       to be sent using a single command.
  405.  
  406.                       LF <On or Off>
  407.                       This command turns the line feed mode for the TYPE
  408.                       and ACCEPT Host mode commands on or off.  If the
  409.                       argument is specified as ON, the host will add line
  410.                       feed characters after carriage returns in transmitted
  411.                       or echoed data.  If the argument is specified as OFF,
  412.                       no line feed characters are added.  The line feed
  413.                       mode initially is set to ON.
  414.  
  415.                       LOGOUT
  416.                       Terminate the current Host mode session and
  417.                       restart with logon processing without a disconnect.
  418.  
  419.                       RECEIVE <profile_name or protocol_name> filename
  420.                       Prepare the Host system to receive the designated
  421.                       file using the specified File Transfer profile or
  422.                       File Transfer Protocol.  If a profile and a protocol
  423.                       share the same name, the command will use the
  424.                       profile.
  425.  
  426.                       Note:  This method lets you use the Honeywell- Kermit
  427.                       protocol with the desired GCOS Mapping setting by
  428.                       using the appropriate profile.
  429.  
  430.                       RENAME d:\path\filename1 d:\path\filename2
  431.                       Change the name of a file in the current or a
  432.                       specified directory.  The first file name entered
  433.                       with optional drive and path specification is the
  434.                       file to be renamed, and the second file name is the
  435.                       new name.  A drive or path specification is not
  436.  
  437.  
  438.  
  439.  
  440.                                               - 7 -
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.                       allowed in the new filename.  The ? and *  wildcard
  448.                       characters are allowed.
  449.  
  450.                       This command can be abbreviated to REN.
  451.  
  452.                       SEND <profile_name or protocol_name> filename
  453.                       Prepare the Host system to send the designated file
  454.                       using the specified File Transfer profile or File
  455.                       Transfer Protocol.  If a profile and a protocol share
  456.                       the same name, the command will use the profile.
  457.  
  458.                       Note:  This method lets you use the Honeywell- Kermit
  459.                       protocol with the desired GCOS Mapping setting by
  460.                       using the appropriate profile.
  461.  
  462.                       TERMINATE
  463.                       Terminate Host mode processing to interact directly
  464.                       with the script file from which the HOST() command
  465.                       was started.  If the optional Host mode logon
  466.                       processing is in effect, the command is restricted by
  467.                       the access restriction code.
  468.  
  469.                       TYPE d:\path\filename
  470.                       Cause a file to be typed or displayed by the Host
  471.                       system.  The command is equivalent to a character
  472.                       protocol SEND command.  The display can be cancelled
  473.                       by entering Ctrl C.
  474.  
  475.                       XRCV d:\path\filename
  476.                       Prepare the Host system to receive the designated
  477.                       file using the Xmodem protocol.  The filename
  478.                       specifies the file to receive the data.
  479.  
  480.                       Note:  The caller may send the file using Xmodem,
  481.                       Xmodem-CRC or Xmodem(Large Block) and the Host system
  482.                       will detect and adjust for the error correction
  483.                       method and block size.
  484.  
  485.                       XSEND d:\path\filename
  486.                       Prepare the Host system to send the designated file
  487.                       using the Xmodem protocol.
  488.  
  489.                       X1KSEND d:\path\filename
  490.                       Prepare the Host system to send the designated file
  491.                       using the Xmodem (Large Block) protocol.
  492.  
  493.                       YGRCV [d:\path\filename]
  494.                       Prepare the Host system to receive the designated
  495.                       file using the Ymodem-G protocol.  The wildcard
  496.                       characters * and ? may be used in the filename or
  497.                       extension to allow multiple files to be transferred
  498.                       using a single command.
  499.  
  500.  
  501.  
  502.  
  503.  
  504.                                               - 8 -
  505.  
  506.  
  507.  
  508.  
  509.  
  510.  
  511.                       If the optional drive, path and file name are not
  512.                       specified, the command will use the data in the
  513.                       protocol header block.
  514.  
  515.                       YRCV [d:\path\filename]
  516.                       Prepare the Host system to receive the designated
  517.                       file using the Ymodem protocol.  The wildcard
  518.                       characters * and ? may be used in the filename or
  519.                       extension to allow multiple files to be transferred
  520.                       using a single command.
  521.  
  522.                       If the optional drive, path and file name are not
  523.                       specified, the command will use the data in the
  524.                       protocol header block.
  525.  
  526.                       Note:  The caller may send the file using Ymodem or
  527.                       Ymodem (Large Block) and the Host system will detect
  528.                       and adjust for the block size.
  529.  
  530.                       YSEND d:\path\filename
  531.                       Prepare the Host system to send the designated file
  532.                       using the Ymodem protocol.  The wildcard characters *
  533.                       and ? may be used in the filename or extension to
  534.                       allow multiple files to be transferred using a single
  535.                       command.
  536.  
  537.                       Note:  The caller may specify Ymodem-G to receive the
  538.                       file and the Host system will detect and adjust for
  539.                       the block size and transmission method.
  540.  
  541.                       Y1KSEND d:\path\filename
  542.                       Prepare the Host system to send the designated file
  543.                       using the Ymodem (Large Block) protocol.  The
  544.                       wildcard characters * and ? may be used in the
  545.                       filename or extension to allow multiple files to be
  546.                       transferred using a single command.
  547.  
  548.                       Note:  The caller may specify Ymodem-G to receive the
  549.                       file and the Host system will detect and adjust for
  550.                       the block size and transmission method.
  551.  
  552.  
  553.  
  554.  
  555.  
  556.  
  557.  
  558.  
  559.  
  560.  
  561.  
  562.  
  563.  
  564.  
  565.  
  566.  
  567.  
  568.                                               - 9 -
  569.  
  570.  
  571.  
  572.  
  573.  
  574.  
  575.                       Softerm-to-Softerm File Transfers
  576.  
  577.                       System-to-system file transfers using Softerm are
  578.                       accomplished by placing a port on one of the two
  579.                       systems in the Host mode using the HOST() command.
  580.                       The other system then can establish a connection with
  581.                       the agreed upon serial parameters.  Once connected,
  582.                       the system in Host mode will transmit the READY
  583.                       message to the other system.
  584.  
  585.                       The system in Host mode will respond to commands
  586.                       entered by the remote system through terminal
  587.                       interaction, or to Softrans and Kermit file transfer
  588.                       commands SEND and RECEIVE entered from the File Menu
  589.                       or script file processing.
  590.  
  591.  
  592.  
  593.  
  594.  
  595.  
  596.  
  597.  
  598.  
  599.  
  600.  
  601.  
  602.  
  603.  
  604.  
  605.  
  606.  
  607.  
  608.  
  609.  
  610.  
  611.  
  612.  
  613.  
  614.  
  615.  
  616.  
  617.  
  618.  
  619.  
  620.  
  621.  
  622.  
  623.  
  624.  
  625.  
  626.  
  627.  
  628.  
  629.  
  630.  
  631.  
  632.                                              - 10 -
  633.